

package com.hazelcast.spi.impl.operationservice;

/**
 * An interface that can be implemented by an operation to indicate that it should
 * be invoked on a particular partition.
 * <p>
 * This interface only has meaning for documentation purposes. Because every operation has a {@link Operation#getPartitionId()}
 * method, the system will use that to determine if an Operation is partition-aware. So the system is fine if you create
 * an Operation that doesn't implement PartitionAwareOperation, but returns a partitionId equal or larger than 0 (and therefore is
 * partition-specific). But it is also fine if you do implement the PartitionAwareOperation interface and return -1 as
 * partition ID (the operation therefore is not specific to a partition).
 *
 * @author mdogan 12/3/12
 */
public interface PartitionAwareOperation {

    /**
     * Gets the partition ID.
     *
     * @return the partition ID
     * @see Operation#getPartitionId()
     */
    int getPartitionId();
}
